<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>jld.tools.cmd_ui.UIBase</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="jld-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="jld-module.html">Package&nbsp;jld</a> ::
        <a href="jld.tools-module.html">Package&nbsp;tools</a> ::
        <a href="jld.tools.cmd_ui-module.html">Module&nbsp;cmd_ui</a> ::
        Class&nbsp;UIBase
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="jld.tools.cmd_ui.UIBase-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class UIBase</h1><p class="nomargin-top"><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">UIBase</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="jld.backup.mindmeister_ui.MM_UI-class.html">backup.mindmeister_ui.MM_UI</a></li><li>, <a href="jld.backup.delicious_ui.Delicious_UI-class.html">backup.delicious_ui.Delicious_UI</a></li><li>, <a href="jld.backup.mmd.mmdUI-class.html">backup.mmd.mmdUI</a></li>  </ul>
</dd></dl>

<hr />
<p>Base class for Command Line UI</p>

<hr />
<div class="fields">      <p><strong>See Also:</strong>
        mindmeister.py for example
      </p>
</div><!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.tools.cmd_ui.UIBase-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">msgs</span>=<span class="summary-sig-default">None</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_resolveHelp"></a><span class="summary-sig-name">_resolveHelp</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">entry</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase._resolveHelp">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.tools.cmd_ui.UIBase-class.html#copyOptions" class="summary-sig-name">copyOptions</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">source</span>,
        <span class="summary-sig-arg">target</span>,
        <span class="summary-sig-arg">_options</span>)</span><br />
      Copies all options from source to target</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.copyOptions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="handleArguments"></a><span class="summary-sig-name">handleArguments</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">usage</span>,
        <span class="summary-sig-arg">_options</span>)</span><br />
      Processes command line options</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.handleArguments">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.tools.cmd_ui.UIBase-class.html#handleError" class="summary-sig-name">handleError</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">exc</span>)</span><br />
      Displays, if required, an appropriate user message corresponding to 
      an error condition.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.handleError">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.tools.cmd_ui.UIBase-class.html#integrateDefaults" class="summary-sig-name">integrateDefaults</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">defs</span>,
        <span class="summary-sig-arg">reg</span>,
        <span class="summary-sig-arg">_options</span>,
        <span class="summary-sig-arg">params</span>)</span><br />
      Integrates the default values for each option if no value can be 
      found in the registry.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.integrateDefaults">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.tools.cmd_ui.UIBase-class.html#integrateOptions" class="summary-sig-name">integrateOptions</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">options</span>,
        <span class="summary-sig-arg">params</span>,
        <span class="summary-sig-arg">_options</span>)</span><br />
      Integrate options that aren't subjected to the registry</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.integrateOptions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="popArg"></a><span class="summary-sig-name">popArg</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Pops one argument from the list</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.popArg">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setParams"></a><span class="summary-sig-name">setParams</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">msgs</span>)</span><br />
      Generic parameter setting interface</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.setParams">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="updateRegistry"></a><span class="summary-sig-name">updateRegistry</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">reg</span>,
        <span class="summary-sig-arg">options</span>,
        <span class="summary-sig-arg">args</span>)</span><br />
      Updates the registry from the command-line args</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.updateRegistry">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="verifyType"></a><span class="summary-sig-name">verifyType</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">params</span>,
        <span class="summary-sig-arg">_options</span>)</span><br />
      Performs type verification</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.verifyType">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="_platform_win32"></a><span class="summary-name">_platform_win32</span> = <code title="True">True</code>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">msgs</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="copyOptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">copyOptions</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">source</span>,
        <span class="sig-arg">target</span>,
        <span class="sig-arg">_options</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.copyOptions">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Copies all options from source to target</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>source</code></strong> - the source dictionary</li>
        <li><strong class="pname"><code>target</code></strong> - the target object with dictionary access</li>
        <li><strong class="pname"><code>_options</code></strong> - the reference options list</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="handleError"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">handleError</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">exc</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.handleError">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Displays, if required, an appropriate user message corresponding to an
  error condition.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>exc</code></strong> - Exception being raised</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="integrateDefaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">integrateDefaults</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">defs</span>,
        <span class="sig-arg">reg</span>,
        <span class="sig-arg">_options</span>,
        <span class="sig-arg">params</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.integrateDefaults">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Integrates the default values for each option if no value can be found
  in the registry.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>defs</code></strong> - the defaults dictionary</li>
        <li><strong class="pname"><code>reg</code></strong> - the registry dictionary</li>
        <li><strong class="pname"><code>_options</code></strong> - the options list</li>
        <li><strong class="pname"><code>params</code></strong> - the result dictionary</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="integrateOptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">integrateOptions</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">options</span>,
        <span class="sig-arg">params</span>,
        <span class="sig-arg">_options</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.tools.cmd_ui-pysrc.html#UIBase.integrateOptions">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Integrate options that aren't subjected to the registry</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>options</code></strong> - the current options as parsed from the command line</li>
        <li><strong class="pname"><code>params</code></strong> - the result dictionary</li>
        <li><strong class="pname"><code>_options</code></strong> - the reference options list</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="jld-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Dec 11 14:16:29 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
